Configuring Analytic inputs

The Analytic selected to be used within your blueprint will define the inputs required. Map the required inputs to available input fields from the input ports.

Input fields required

The Input Tab contains a list of Input data fields required, as defined by the Analytic. It is possible to have more than one occurrence of input fields to each Analytic field, as defined within the Analytic.

Multiplicity in analytics inputs

The analytics block supports analytics with multiple occurrences of single analytic input field (It functions like array type). The is determined by a variable flag in the analytic template by the publisher of the Analytic.

  • When variable flag is false, then there will be one input field mapped for each required Analytic input. There is no [+] or [-] expander buttons in the first column. Click the button to do the mapping.

  • When the variable flag is true, then there can be more than one input field mapped for each required Analytic input.

      • The row on the Inputs tab grid will show a parent – child relationship
      • The parent row 1st column has a [+] or [-] expander button to open or close the child grid. The parent row will not have the button, it will have the button to add more child rows.
      • The parent row itself cannot be mapped. Mapping happens with the child rows, even if there is only 1 child row.
      • The child rows will have the same columns as the parent row. The Field column can be mapped.
      • The button will always be available for the child row and will display a mapping dialog.
      • You can continue adding more input fields until the expander button is no longer visible. This means you have reached the defined maximum number of rows that can all be mapped to the same Analytic input. Delete one or more child rows to enable the again, and add more child rows.
      • The child row has a button column at the end of the row - use this to delete the row.  
      • Delete each child row, if required, until the minimum occurrence limit is reached. After this, no more child rows can be deleted.

Input field columns

  • Input Data: the input data field name from the Analytic (Read-only)

  • Units: the unit of measure for this Analytic field (Read-only)

  • Data Type: the OSA-CBM data type of this field (Read-only)

  • Field: the user mapped field or fields. (Read-only. Use the [Edit...] button to change the input field mappings.) This can be the input port Proficy CSense mapped value.

  • Edit: This displays the custom dialog to manually select an input field for mapping.

The buttons on the dialog are:

  • Quick Mapping: displays the “Quick Map” dialog.

  • Import: imports a previously exported input data mapping as a CSV file. The current values of the input fields get cleared and the new data is imported. The input field mapping minimum and maximum occurrences number gets reset to default values and additional rows are added if they are defined in the imported file. The field names and data types are validated on import.

  • Export: exports the input data grid to a CSV file.

Filtering Available Fields

Both the Available Fields and Data Types columns in the Available Fields grid can be filtered.

Note: The filtering is cascaded, meaning if a filter is applied to the Available Fields column and then applied to the Data Type column, only the Available Fields filtered initially will be assessed in the second Data Type filter.

  1. Click on the filter cone image in the column header.

  2. Select the type of filtering option required from the populated list.

    • By default, the filter "Contains" is selected.

    • "Custom" filters allow you to select a combination of actions, with ban operators.

    • Field names or field data types can be selected to be filtered.

  3. Complete the Filter text box… with the required filtering term.

    • Filtering terms are not case sensitive.

Quick mapping

Clicking [Quick Mapping] will display the quick map dialog. This will show a list of all simple fields (non-array, non-vector, non-complex) data types on the left side, and on the right, the Input port Proficy CSense fields. Map one Analytic field on the left with one or more Input data field in the lower right.

This dialog allows you to create more child rows, and delete child rows according to the input field mapping occurrences predefined within the Analytic.  If the number of child rows is at the predefined maximum limit, then the [+] button on the parent field is hidden. The [+] button is made visible again when deleting one or more of the child rows, taking the number of occurrences to below the defined maximum number. If there are no child row, then the expander symbol column is blank.

The Available Input Sources will show the Proficy CSense input port fields. Click on the required node to select an input field from the correct source. The table on the lower right lists all the available fields in that Available Input Source that match the corresponding Analytic field data type and are therefore available to be mapped to the Analytic OSA-CBM data type.

  • The lower right list will show input port fields when the input port is selected in the tree.

  • The lower right list is filtered to show only fields compatible with the data type of the Analytic OSA CBM field.

Map the relevant required and available fields as follows:  

  1. From the list of Available Input Sources, select the source of the data field - from fields in the block's Input Port/s.

  2. You can select more than one Analytic input field to map to at a time (multi-select) but only one input field from the table on the right.

  3. Click [<] to map the selected Proficy CSense input field, only if the data types match. These fields do not get removed from the Available Fields list.

  4. Use [<<] to automatically map all fields all rows on the left with all rows on the right based on matching field names and data types.  

  5. Click [>] to clear the mapping of the selected Analytic field on the left.  

  6. Click [>>] to clear all mappings of all rows on the left.

Notes on Quick Mapping with minimum and maximum row occurrences:

  • Double clicking the row on the right will map the selected row on the right with the selected rows on the left.

  • If a row with no child rows is selected, then mapping will be directly to that row.

  • If a parent row is selected, and you click [<], then the mapping will automatically be to all of its children, only if its child rows are not already selected.

    • All child rows will be set to the same value.

    • If the parent and one or more of its child rows are selected, then the mapping will only be to the selected child rows.

  • If a parent row is selected and you click [>] then nothing gets unmapped. You need to select the relevant child rows and click [>] to unmap the fields.

  • If a row with no child rows is selected and you click [>], that row will be un-mapped.

Supported OSA-CBM data types

For this dialog, all OSA-CBM fields shown on the input data grid that are of the following data types will be displayed:

Integer types:

  •  DAInt

  •  DMInt

  •  SDInt

  •  SDTestInt

Bool types:

  • DABool

  • DMBool

  • SDBool

Real types:

  • DAReal

  • DMReal

  • SDReal

  • SDTestReal

  • DMAmpl

String types:

  •  DAString

OSA-CBM and corresponding Proficy CSense data types

We will allow the corresponding Proficy CSense data types to map to the OSA-CBM data types as shown below:

Integer types:

  •  DAInt = INTEGER

  •  DMInt = INTEGER

  •  SDInt = INTEGER

  •  SDTestInt = INTEGER

Bool types:

  • DABool = INTEGER

  • DMBool = INTEGER

  • SDBool = INTEGER

Real types:

  • DAReal = INTEGER, DOUBLE

  • DMReal = INTEGER, DOUBLE

  • SDReal = INTEGER, DOUBLE

  • SDTestReal = INTEGER, DOUBLE

  • DMAmpl = INTEGER, DOUBLE

String types:

  • DAString = STRING

Simple field selection

This dialog is displayed when pressing [Edit] on the input data grid for the data types listed below. Map one Analytic field on the left with one Input data field in the lower right.

The Available Input Sources will show the Proficy CSense input port fields.  The table on the lower right lists all the available fields in that Available Input Source that match the corresponding Analytic field data type and are therefore available to be mapped to the Analytic OSA-CBM data type.

  • The lower right list will show input port fields when the input port is selected in the tree.

  • The lower right list is filtered to show only fields compatible with the data type of the Analytic OSA CBM field.

  1. Click [<] to map the selected Proficy CSense input fields. These fields do not get removed from the Available Fields list.

  2. Click [>] to clear the selected mapped field.  

Simple field OSA-CBM data types

Integer types:

  •  DAInt = INTEGER

  •  DMInt = INTEGER

  •  SDInt = INTEGER

  •  SDTestInt = INTEGER

Bool types:

  • DABool = INTEGER

  • DMBool = INTEGER

  • SDBool = INTEGER

Real types:

  • DAReal = INTEGER, REAL

  • DMReal = INTEGER, DOUBLE

  • SDReal = INTEGER, DOUBLE

  • SDTestReal = INTEGER, DOUBLE

  • DMAmpl = INTEGER, DOUBLE

String types:

  • DAString = STRING

Unsupported OSA-CBM data types

This dialog will also allow the following unsupported data types shown below to be mapped to Proficy CSense string values.

  • AGDataEvent = STRING

  • AGInvalid = STRING

  • AGUnknown = STRING

  • DABLOBData = STRING

  • DAInvalid = STRING

  • DAUnknown = STRING

  • DEUser = STRING

  • DMBLOBData = STRING

  • DMInvalid = STRING

  • DMUnknown = STRING

  • DMUserDef = STRING

  • HADataEvent = STRING

  • HAInvalid = STRING

  • HAUnknown = STRING

  • InvalidUnsetType = STRING

  • PADataEvent = STRING

  • PAFutureHlth = STRING

  • PAFutureHlthTrend = STRING

  • PAInvalid = STRING

  • PARUL = STRING

  • PARULDist = STRING

  • PAUnknown = STRING

  • SDEnum = STRING

  • SDEnumSet = STRING

  • SDEvent = STRING

  • SDInvalid = STRING

  • SDUnknown = STRING

Array field selection

Map the Analytic input field on the left with an array of Input data fields listed in the lower right table. Alternatively, map a constant value to the Analytic input field.

The array field selection dialog is displayed when pressing [Edit] on the input data grid for an OSA-CBM field of the data types:

Array field OSA-CBM data types

  • DMCPB = INTEGER, DOUBLE

  • DMRealFrqSpect = INTEGER, DOUBLE

  • DMRealWaveform = INTEGER, DOUBLE

  • DADataSeq = INTEGER, DOUBLE

  • DMDataSeq = INTEGER, DOUBLE

  • DAWaveform = INTEGER, DOUBLE

  • DAValueWaveform = INTEGER, DOUBLE, STRING

  • DAValueDataSeq = INTEGER, DOUBLE, STRING

  1. Enter an array size and click [Generate]. This adds the required number of blank rows to the mapped field list for the array size entered.

  2. If you decide to change the array size and click [Generate], either new blank rows will be added to the bottom of the list if the new array size is larger than the old, or blank rows will be removed from the bottom of the list if the new array size is smaller than the old.

  3. The Available Input Sources will show the Proficy CSense input port fields. The table on the lower right lists all the available fields in that Available Input Source that match the corresponding Analytic field data type and are therefore available to be mapped to the Analytic OSA-CBM data type.

    • The lower right list will show input port fields when the input port is selected in the tree.

    • The lower right list is filtered to show only fields compatible with the data type of the Analytic OSA CBM field.

  4. If there was a pre-existing mapped input field for this required field, then you do not need to generate the array size and the mapped field list will show the previously mapped fields in table format.

  5. Select a row on the left to which the fields on the right must be mapped. Either double click a single field on the right to map it to the selected row on the left, or use the arrow buttons. The selected row on the left advances to the next row.

  6. Click [<] to map one or more selected Proficy CSense fields. These fields do not get removed from the Available Fields list. If multiple fields are selected to be mapped, the rows are copied and placed on the left starting with the “selected” row and the other rows are copied below it.

  7. Click [>] to clear the selected mapped field.  

  8. Click [>>] to clear all mappings of all rows on the left.

  9. Enter a constant value and click [<] to map the constant value.

Array field syntax

Clicking [OK] will show the input data mapped array string with the following syntax: [ F1; F2; F3; F4 ] where F1-F4 are Proficy CSense field names or constants. The white spaces are optional.  Note that if you do not fill in all of the mappings on the left side list of the Array Field Selection Dialog, they will automatically be filled in with 0’s.

Vector array field selection

Map the Analytic input field on the left with an array of Input data fields listed in the lower right table. Alternatively, map a constant value to the Analytic input field.

The vector array field selection dialog is displayed when when pressing [Edit] on the input data grid for an OSA-CBM field of the following data types:

Vector array OSA-CBM data types

  • DAVector = INTEGER, DOUBLE

  • DMVector = INTEGER, DOUBLE

  1. Enter an array size and click [Generate]. This adds the required number of blank rows to the mapped field list for the array size entered.

  2. If you decide to change the array size and click [Generate], either new blank rows will be added to the bottom of the list if the new array size is larger than the old, or blank rows will be removed from the bottom of the list if the new array size is less than the old.

    Note that this dialog has 2 mapping rows per OSA-CBM field. One is for the Vector Value and the other is for the Real Value.

  3. The Available Input Sources will show the Proficy CSense input port fields. The table on the lower right lists all the available fields in that Available Input Source that match the corresponding Analytic field data type and are therefore available to be mapped to the Analytic OSA-CBM data type.

    • The lower right list will show input port fields when the input port is selected in the tree.

    • The lower right list is filtered to show only fields compatible with the data type of the Analytic OSA CBM field.

  4. If there was a pre-existing mapped input field for this required field, then you do not need to generate the array size and the left list will show the mapped fields in table format.

  5. Select a row on the left to which the fields on the right must be mapped. Either double click a single field on the right to map it to the selected row on the left, or use the arrow buttons. The selected row on the left advances to the next row.

  6. Click [<] to map one or more selected Proficy CSense fields. These fields do not get removed from the Available Fields list. If multiple fields are selected to be mapped, the rows are copied and placed on the left starting with the “selected” row and the other rows are copied below it.

  7. Click [>] to clear the selected mapped field.  

  8. Click [>>] to clear all mappings of all rows on the left.

  9. Enter a constant value and click [<] to map the constant value.

Vector array field syntax

Clicking [OK] will show the input data mapped array string with the following syntax: [  [ F1; F2 ] [ F3; F4 ] ] where F1-F4 are Proficy CSense field names or constants. The white spaces are optional. Note that if you do not fill in all of the mappings on the left side list of the Array Field Selection Dialog, they will automatically be filled in with 0’s.

Complex array field selection

Map the Analytic input field on the left with a complex array of Input data fields listed in the lower right table. Alternatively, map a constant value to the Analytic input field.

The complex array field selection dialog is displayed when pressing [Edit] on the input data grid for an OSA-CBM field of the data types listed below. There are two columns for mapping: one for a real number, and a second for the imaginary number.  

Complex array OSA-CBM data types

  • DMCmplxFrqSpect = INTEGER, DOUBLE

  • DMCmplxWaveform = INTEGER, DOUBLE

  1. Enter an array size and click [Generate]. This adds the required number of blank rows to the mapped field list for the array size entered.

  2. If you decide to change the array size and click [Generate], either new blank rows will be added to the bottom of the list if the new array size is larger than the old, or blank rows will be removed from the bottom of the list if the new array size is smaller than the old.

    Note that this dialog has 2 mapping columns per OSA-CBM field. One column is for the Real Value, the other column is for the Imaginary Value.

  3. The Available Input Sources will show the Proficy CSense input port fields. The table on the lower right lists all the available fields in that Available Input Source that match the corresponding Analytic field data type and are therefore available to be mapped to the Analytic OSA-CBM data type.

    • The lower right list will show input port fields when the input port is selected in the tree.

    • The lower right list is filtered to show only fields compatible with the data type of the Analytic OSA CBM field.

  4. If there was a pre-existing mapped input field for this required field, then you do not need to generate the array size and the mapped field list will show the previously mapped fields in table format.

  5. Select a row on the left to which the fields on the right must be mapped. Either double click a single field on the right to map it to the selected row on the left, or use the arrow buttons. The selected row on the left advances to the next row.

  6. Click [<R] to map one or more selected Proficy CSense fields to the Real Value Column. These fields do not get removed from the Available Fields list. If multiple fields are selected to be mapped, the rows are copied and placed on the left starting with the “selected” row and the other rows are copied below it.

  7. Click [<i] to map one or more selected Proficy CSense to the a Imaginary Value Column. These fields do not get removed from the Available Fields list. If multiple fields are selected to be mapped, the rows are copied and placed on the left starting with the “selected” row and the other rows are copied below it.

  8. Click [>] to clear the selected mapped field.  

  9. Click [>>] to clear all mappings of all rows on the left.

  10. Enter a constant value and click [<R] or [<i] to map the constant value to the Real Value column or Imaginary Value column respectively.

Complex array field syntax

Clicking [OK] will show the input data mapped array string with the following syntax: [  [ F1; F2 ] [ F3; F4 ] ] where F1-F4 are Proficy CSense field names or constants. The white spaces are optional. Note that if you do not fill in all of the mappings on the left side list of the Array Field Selection Dialog, they will automatically be filled in with 0’s.


Related topics:

  

CSense 2023- Last updated: June 24,2025